{ "bundles": [ { "@type": "NXBundle", "artifactId": "nuxeo-importer-core", "artifactVersion": "2021.49.2", "bundleGroup": { "@type": "NXBundleGroup", "bundleIds": [ "org.nuxeo.ecm.platform.importer.core", "org.nuxeo.ecm.platform.importer.jaxrs" ], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer", "id": "grp:org.nuxeo.ecm.platform.importer", "name": "org.nuxeo.ecm.platform.importer", "parentIds": [ "grp:org.nuxeo.ecm.platform" ], "readmes": [ { "blobProviderId": "default", "content": "# Nuxeo Platform Importer\n\n## About Nuxeo Platform Importer\n\nThe file importer comes as a Java library (with nuxeo runtime service) and a sample JAX-RS interface to launch, monitor and abort import jobs.\nThis project is an on-going project, supported by Nuxeo\n\n## Building\n### How to Build Nuxeo Platform Importer\nBuild the Nuxeo Platform Importer with Maven:\n```$ mvn install -Dmaven.test.skip=true```\n\n## Deploying\nNuxeo Platform Importer is available as two package add-ons [from the Nuxeo Marketplace]\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-platform-importer\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-scan-importer\n\n## Resources\n### Documentation\nThe documentation for Nuxeo Platform Importer is available in our Documentation Center: http://doc.nuxeo.com/x/gYBVAQ\n\n### Reporting Issues\nYou can follow the developments in the Nuxeo Platform project of our JIRA bug tracker, which includes a Nuxeo Platform Importer component:\nhttps://jira.nuxeo.com/browse/NXP/component/10621\n\nYou can report issues on: http://answers.nuxeo.com/\n\n## About Nuxeo\nNuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.\n", "digest": "83bb2a4c6415c9f07db3ab17fa99510c", "encoding": "UTF-8", "length": 1753, "mimeType": "text/plain", "name": "README.md" } ], "version": "2021.49" }, "bundleId": "org.nuxeo.ecm.platform.importer.core", "components": [ { "@type": "NXComponent", "documentationHtml": "", "extensionPoints": [], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.core.convert.service.ConversionServiceImpl--converter", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.core/org.nuxeo.ecm.platform.iomporter.convert/Contributions/org.nuxeo.ecm.platform.iomporter.convert--converter", "id": "org.nuxeo.ecm.platform.iomporter.convert--converter", "registrationOrder": 1, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.core.convert.service.ConversionServiceImpl", "name": "org.nuxeo.ecm.core.convert.service.ConversionServiceImpl", "type": "service" }, "version": "2021.49.2", "xml": "\n\n \n text/partial\n text/plain\n \n\n " } ], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.core/org.nuxeo.ecm.platform.iomporter.convert", "name": "org.nuxeo.ecm.platform.iomporter.convert", "requirements": [ "org.nuxeo.ecm.core.convert.plugins" ], "resolutionOrder": 214, "services": [], "startOrder": 343, "version": "2021.49.2", "xmlFileContent": "\n\n\n\n org.nuxeo.ecm.core.convert.plugins\n \n\n \n text/partial\n text/plain\n \n\n \n\n\n", "xmlFileName": "/OSGI-INF/convert-service-contrib.xml", "xmlPureComponent": true }, { "@type": "NXComponent", "componentClass": "org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent", "documentation": "\n This allows to configure the default importer by contributing a specific\n documentFactory and sourceNode implementations\n\n \n \n \n \n default\n true\n true\n \n \n\n", "documentationHtml": "

\nThis allows to configure the default importer by contributing a specific\ndocumentFactory and sourceNode implementations\n

\n

    <extension point="importerConfiguration" target="org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent">\n        <importerConfig sourceNodeClass="org.nuxeo.ecm.platform.importer.source.FileSourceNode">\n            <documentModelFactory\n                documentModelFactoryClass="org.nuxeo.ecm.platform.importer.factories.DefaultDocumentModelFactory"\n                folderishType="Folder" leafType="File"/>\n            <repository>default</repository>\n            <bulkMode>true</bulkMode>\n            <enablePerfLogging>true</enablePerfLogging>\n        </importerConfig>\n    </extension>\n

", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent", "descriptors": [ "org.nuxeo.ecm.platform.importer.service.ImporterConfigurationDescriptor" ], "documentationHtml": "", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.core/org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent/ExtensionPoints/org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent--importerConfiguration", "id": "org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent--importerConfiguration", "label": "importerConfiguration (org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent)", "name": "importerConfiguration", "version": "2021.49.2" } ], "extensions": [], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.core/org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent", "name": "org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent", "requirements": [], "resolutionOrder": 215, "services": [ { "@type": "NXService", "componentId": "org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.core/org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent/Services/org.nuxeo.ecm.platform.importer.service.DefaultImporterService", "id": "org.nuxeo.ecm.platform.importer.service.DefaultImporterService", "overriden": false, "version": "2021.49.2" } ], "startOrder": 865, "version": "2021.49.2", "xmlFileContent": "\n\n\n \n This allows to configure the default importer by contributing a specific\n documentFactory and sourceNode implementations\n\n \n \n \n \n default\n true\n true\n \n \n \n\n \n\n \n\n \n \n \n\n \n \n \n\n\n", "xmlFileName": "/OSGI-INF/default-importer-service.xml", "xmlPureComponent": false } ], "fileName": "nuxeo-importer-core-2021.49.2.jar", "groupId": "org.nuxeo.ecm.platform", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.core", "id": "org.nuxeo.ecm.platform.importer.core", "location": "", "manifest": "Manifest-Version: 1.0\r\nArchiver-Version: Plexus Archiver\r\nCreated-By: Apache Maven\r\nBuilt-By: root\r\nBuild-Jdk: 11.0.21\r\nBundle-ManifestVersion: 1\r\nBundle-Version: 1.0.0\r\nBundle-Name: Nuxeo ECM Importer\r\nBundle-SymbolicName: org.nuxeo.ecm.platform.importer.core;singleton:=t\r\n rue\r\nNuxeo-Component: OSGI-INF/convert-service-contrib.xml,OSGI-INF/default\r\n -importer-service.xml\r\n\r\n", "maxResolutionOrder": 215, "minResolutionOrder": 214, "packages": [ "nuxeo-platform-importer" ], "parentReadme": { "blobProviderId": "default", "content": "# Nuxeo Platform Importer\n\n## About Nuxeo Platform Importer\n\nThe file importer comes as a Java library (with nuxeo runtime service) and a sample JAX-RS interface to launch, monitor and abort import jobs.\nThis project is an on-going project, supported by Nuxeo\n\n## Building\n### How to Build Nuxeo Platform Importer\nBuild the Nuxeo Platform Importer with Maven:\n```$ mvn install -Dmaven.test.skip=true```\n\n## Deploying\nNuxeo Platform Importer is available as two package add-ons [from the Nuxeo Marketplace]\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-platform-importer\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-scan-importer\n\n## Resources\n### Documentation\nThe documentation for Nuxeo Platform Importer is available in our Documentation Center: http://doc.nuxeo.com/x/gYBVAQ\n\n### Reporting Issues\nYou can follow the developments in the Nuxeo Platform project of our JIRA bug tracker, which includes a Nuxeo Platform Importer component:\nhttps://jira.nuxeo.com/browse/NXP/component/10621\n\nYou can report issues on: http://answers.nuxeo.com/\n\n## About Nuxeo\nNuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.\n", "digest": "83bb2a4c6415c9f07db3ab17fa99510c", "encoding": "UTF-8", "length": 1753, "mimeType": "text/plain", "name": "README.md" }, "requirements": [], "version": "2021.49.2" }, { "@type": "NXBundle", "artifactId": "nuxeo-importer-jaxrs", "artifactVersion": "2021.49.2", "bundleGroup": { "@type": "NXBundleGroup", "bundleIds": [ "org.nuxeo.ecm.platform.importer.core", "org.nuxeo.ecm.platform.importer.jaxrs" ], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer", "id": "grp:org.nuxeo.ecm.platform.importer", "name": "org.nuxeo.ecm.platform.importer", "parentIds": [ "grp:org.nuxeo.ecm.platform" ], "readmes": [ { "blobProviderId": "default", "content": "# Nuxeo Platform Importer\n\n## About Nuxeo Platform Importer\n\nThe file importer comes as a Java library (with nuxeo runtime service) and a sample JAX-RS interface to launch, monitor and abort import jobs.\nThis project is an on-going project, supported by Nuxeo\n\n## Building\n### How to Build Nuxeo Platform Importer\nBuild the Nuxeo Platform Importer with Maven:\n```$ mvn install -Dmaven.test.skip=true```\n\n## Deploying\nNuxeo Platform Importer is available as two package add-ons [from the Nuxeo Marketplace]\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-platform-importer\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-scan-importer\n\n## Resources\n### Documentation\nThe documentation for Nuxeo Platform Importer is available in our Documentation Center: http://doc.nuxeo.com/x/gYBVAQ\n\n### Reporting Issues\nYou can follow the developments in the Nuxeo Platform project of our JIRA bug tracker, which includes a Nuxeo Platform Importer component:\nhttps://jira.nuxeo.com/browse/NXP/component/10621\n\nYou can report issues on: http://answers.nuxeo.com/\n\n## About Nuxeo\nNuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.\n", "digest": "83bb2a4c6415c9f07db3ab17fa99510c", "encoding": "UTF-8", "length": 1753, "mimeType": "text/plain", "name": "README.md" } ], "version": "2021.49" }, "bundleId": "org.nuxeo.ecm.platform.importer.jaxrs", "components": [ { "@type": "NXComponent", "documentationHtml": "", "extensionPoints": [], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent--importerConfiguration", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.jaxrs/org.nuxeo.ecm.platform.importer.service.jaxrs.contrib/Contributions/org.nuxeo.ecm.platform.importer.service.jaxrs.contrib--importerConfiguration", "id": "org.nuxeo.ecm.platform.importer.service.jaxrs.contrib--importerConfiguration", "registrationOrder": 0, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent", "name": "org.nuxeo.ecm.platform.importer.service.DefaultImporterComponent", "type": "service" }, "version": "2021.49.2", "xml": "\n \n \n true\n \n " } ], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.jaxrs/org.nuxeo.ecm.platform.importer.service.jaxrs.contrib", "name": "org.nuxeo.ecm.platform.importer.service.jaxrs.contrib", "requirements": [], "resolutionOrder": 216, "services": [], "startOrder": 340, "version": "2021.49.2", "xmlFileContent": "\n\n\n \n \n \n true\n \n \n\n", "xmlFileName": "/OSGI-INF/importer-service-contrib.xml", "xmlPureComponent": true } ], "fileName": "nuxeo-importer-jaxrs-2021.49.2.jar", "groupId": "org.nuxeo.ecm.platform", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.platform.importer/org.nuxeo.ecm.platform.importer.jaxrs", "id": "org.nuxeo.ecm.platform.importer.jaxrs", "location": "", "manifest": "Manifest-Version: 1.0\r\nArchiver-Version: Plexus Archiver\r\nCreated-By: Apache Maven\r\nBuilt-By: root\r\nBuild-Jdk: 11.0.21\r\nBundle-ManifestVersion: 1\r\nBundle-Version: 1.0.0\r\nBundle-Name: Nuxeo ECM JAXRS Importer\r\nBundle-SymbolicName: org.nuxeo.ecm.platform.importer.jaxrs;singleton:=\r\n true\r\nRequire-Bundle: org.nuxeo.ecm.webengine.core\r\nNuxeo-WebModule: org.nuxeo.ecm.platform.importer.executor.jaxrs.Import\r\n erApp\r\nNuxeo-Component: OSGI-INF/importer-service-contrib.xml\r\n\r\n", "maxResolutionOrder": 216, "minResolutionOrder": 216, "packages": [ "nuxeo-platform-importer" ], "parentReadme": { "blobProviderId": "default", "content": "# Nuxeo Platform Importer\n\n## About Nuxeo Platform Importer\n\nThe file importer comes as a Java library (with nuxeo runtime service) and a sample JAX-RS interface to launch, monitor and abort import jobs.\nThis project is an on-going project, supported by Nuxeo\n\n## Building\n### How to Build Nuxeo Platform Importer\nBuild the Nuxeo Platform Importer with Maven:\n```$ mvn install -Dmaven.test.skip=true```\n\n## Deploying\nNuxeo Platform Importer is available as two package add-ons [from the Nuxeo Marketplace]\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-platform-importer\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-scan-importer\n\n## Resources\n### Documentation\nThe documentation for Nuxeo Platform Importer is available in our Documentation Center: http://doc.nuxeo.com/x/gYBVAQ\n\n### Reporting Issues\nYou can follow the developments in the Nuxeo Platform project of our JIRA bug tracker, which includes a Nuxeo Platform Importer component:\nhttps://jira.nuxeo.com/browse/NXP/component/10621\n\nYou can report issues on: http://answers.nuxeo.com/\n\n## About Nuxeo\nNuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.\n", "digest": "83bb2a4c6415c9f07db3ab17fa99510c", "encoding": "UTF-8", "length": 1753, "mimeType": "text/plain", "name": "README.md" }, "requirements": [ "org.nuxeo.ecm.webengine.core" ], "version": "2021.49.2" }, { "@type": "NXBundle", "artifactId": "nuxeo-importer-stream", "artifactVersion": "2021.49.2", "bundleGroup": { "@type": "NXBundleGroup", "bundleIds": [ "org.nuxeo.binary.metadata", "org.nuxeo.directory.mongodb", "org.nuxeo.dmk-adaptor", "org.nuxeo.ecm.audit.io", "org.nuxeo.ecm.default.config", "org.nuxeo.ecm.jwt", "org.nuxeo.ecm.permissions", "org.nuxeo.ecm.platform", "org.nuxeo.ecm.platform.api", "org.nuxeo.ecm.platform.collections.core", "org.nuxeo.ecm.platform.commandline.executor", "org.nuxeo.ecm.platform.convert", "org.nuxeo.ecm.platform.csv.export", "org.nuxeo.ecm.platform.dublincore", "org.nuxeo.ecm.platform.filemanager", "org.nuxeo.ecm.platform.htmlsanitizer", "org.nuxeo.ecm.platform.mail", "org.nuxeo.ecm.platform.oauth", "org.nuxeo.ecm.platform.oauth1", "org.nuxeo.ecm.platform.pdf", "org.nuxeo.ecm.platform.query.api", "org.nuxeo.ecm.platform.rendering", "org.nuxeo.ecm.platform.threed", "org.nuxeo.ecm.platform.thumbnail", "org.nuxeo.ecm.platform.types", "org.nuxeo.ecm.platform.url", "org.nuxeo.ecm.platform.usermanager", "org.nuxeo.ecm.quota", "org.nuxeo.ecm.webdav", "org.nuxeo.importer.stream", "org.nuxeo.mail", "org.nuxeo.mongodb.audit", "org.nuxeo.search.ui", "org.nuxeo.usermapper" ], "hierarchyPath": "/grp:org.nuxeo.ecm.platform", "id": "grp:org.nuxeo.ecm.platform", "name": "org.nuxeo.ecm.platform", "parentIds": [], "readmes": [ { "blobProviderId": "default", "content": "# Nuxeo Platform Importer\n\n## About Nuxeo Platform Importer\n\nThe file importer comes as a Java library (with nuxeo runtime service) and a sample JAX-RS interface to launch, monitor and abort import jobs.\nThis project is an on-going project, supported by Nuxeo\n\n## Building\n### How to Build Nuxeo Platform Importer\nBuild the Nuxeo Platform Importer with Maven:\n```$ mvn install -Dmaven.test.skip=true```\n\n## Deploying\nNuxeo Platform Importer is available as two package add-ons [from the Nuxeo Marketplace]\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-platform-importer\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-scan-importer\n\n## Resources\n### Documentation\nThe documentation for Nuxeo Platform Importer is available in our Documentation Center: http://doc.nuxeo.com/x/gYBVAQ\n\n### Reporting Issues\nYou can follow the developments in the Nuxeo Platform project of our JIRA bug tracker, which includes a Nuxeo Platform Importer component:\nhttps://jira.nuxeo.com/browse/NXP/component/10621\n\nYou can report issues on: http://answers.nuxeo.com/\n\n## About Nuxeo\nNuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.\n", "digest": "83bb2a4c6415c9f07db3ab17fa99510c", "encoding": "UTF-8", "length": 1753, "mimeType": "text/plain", "name": "README.md" } ], "version": "2021.49" }, "bundleId": "org.nuxeo.importer.stream", "components": [ { "@type": "NXComponent", "documentationHtml": "", "extensionPoints": [], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.core.operation.OperationServiceComponent--operations", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.importer.stream/org.nuxeo.importer.stream.automation.contrib/Contributions/org.nuxeo.importer.stream.automation.contrib--operations", "id": "org.nuxeo.importer.stream.automation.contrib--operations", "registrationOrder": 13, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.core.operation.OperationServiceComponent", "name": "org.nuxeo.ecm.core.operation.OperationServiceComponent", "type": "service" }, "version": "2021.49.2", "xml": "\n \n \n \n \n \n \n " } ], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.importer.stream/org.nuxeo.importer.stream.automation.contrib", "name": "org.nuxeo.importer.stream.automation.contrib", "requirements": [], "resolutionOrder": 217, "services": [], "startOrder": 691, "version": "2021.49.2", "xmlFileContent": "\n\n\n \n \n \n \n \n \n \n \n\n\n", "xmlFileName": "/OSGI-INF/operations-contrib.xml", "xmlPureComponent": true } ], "fileName": "nuxeo-importer-stream-2021.49.2.jar", "groupId": "org.nuxeo.ecm.platform", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.importer.stream", "id": "org.nuxeo.importer.stream", "location": "", "manifest": "Manifest-Version: 1.0\r\nArchiver-Version: Plexus Archiver\r\nCreated-By: Apache Maven\r\nBuilt-By: root\r\nBuild-Jdk: 11.0.21\r\nBundle-ManifestVersion: 1\r\nBundle-Version: 2021.49.2-t20240126-142310\r\nBundle-SymbolicName: org.nuxeo.importer.stream;singleton:=true\r\nBundle-Name: Nuxeo Importer Stream\r\nBundle-Vendor: Nuxeo\r\nNuxeo-Component: OSGI-INF/operations-contrib.xml\r\n\r\n", "maxResolutionOrder": 217, "minResolutionOrder": 217, "packages": [ "nuxeo-platform-importer" ], "parentReadme": { "blobProviderId": "default", "content": "# Nuxeo Platform Importer\n\n## About Nuxeo Platform Importer\n\nThe file importer comes as a Java library (with nuxeo runtime service) and a sample JAX-RS interface to launch, monitor and abort import jobs.\nThis project is an on-going project, supported by Nuxeo\n\n## Building\n### How to Build Nuxeo Platform Importer\nBuild the Nuxeo Platform Importer with Maven:\n```$ mvn install -Dmaven.test.skip=true```\n\n## Deploying\nNuxeo Platform Importer is available as two package add-ons [from the Nuxeo Marketplace]\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-platform-importer\nhttps://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-scan-importer\n\n## Resources\n### Documentation\nThe documentation for Nuxeo Platform Importer is available in our Documentation Center: http://doc.nuxeo.com/x/gYBVAQ\n\n### Reporting Issues\nYou can follow the developments in the Nuxeo Platform project of our JIRA bug tracker, which includes a Nuxeo Platform Importer component:\nhttps://jira.nuxeo.com/browse/NXP/component/10621\n\nYou can report issues on: http://answers.nuxeo.com/\n\n## About Nuxeo\nNuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.\n", "digest": "83bb2a4c6415c9f07db3ab17fa99510c", "encoding": "UTF-8", "length": 1753, "mimeType": "text/plain", "name": "README.md" }, "readme": { "blobProviderId": "default", "content": "nuxeo-importer-stream\n======================\n\n## About\n\nThis module defines a producer/consumer pattern and uses the Log features provided by Nuxeo Stream.\n\n## Producer/Consumer pattern with automation operations\n\nThe Log is used to perform mass import.\n\nIt decouples the Extraction/Transformation from the Load (using the [ETL](https://en.wikipedia.org/wiki/Extract-transform-load) terminology).\n\nThe extraction and transformation is done by a document message producer with custom logic.\n\nThis module comes with a random document and a random blob generator, that does the same job as the random importer of the `nuxeo-importer-core` module.\n\nThe load into Nuxeo is done with a generic consumer.\n\nAutomation operations are exposed to run producers and consumers.\n\n\n### Two steps import: Generate and Import documents with blobs\n\n1. Run a random producers of document messages, these message represent Folder and File document a blob. The total number of document created is: `nbThreads * nbDocuments`.\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runRandomDocumentProducers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"nbDocuments\": 100, \"nbThreads\": 5}}'\n```\n\n| Params| Default | Description |\n| --- | ---: | --- |\n| `nbDocuments` | | The number of documents to generate per producer thread |\n| `nbThreads` | `8` | The number of concurrent producer to run |\n| `avgBlobSizeKB` | `1` | The average blob size fo each file documents in KB. If set to `0` create File document without blob. |\n| `lang` | `en_US` |The locale used for the generated content, can be `fr_FR` or `en_US` |\n| `logName` | `import/doc` | The name of the Log. |\n| `logSize` | `$nbThreads` |The number of partitions in the Log which will fix the maximum number of consumer threads |\n| `logBlobInfo` | | A Log name containing blob information to use, see section below for use case |\n\n2. Run consumers of document messages creating Nuxeo documents, the concurrency will match the previous nbThreads producers parameters\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runDocumentConsumers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"rootFolder\": \"/default-domain/workspaces\"}}'\n```\n\n| Params| Default | Description |\n| --- | ---: | --- |\n| `rootFolder` | | The path of the Nuxeo container to import documents, this document must exists |\n| `repositoryName` | | The repository name used to import documents |\n| `nbThreads` | `logSize` | The number of concurrent consumer, should not be greater than the number of partition in the Log |\n| `batchSize` | `10` | The consumer commit documents every batch size |\n| `batchThresholdS` | `20` | The consumer commit documents if the transaction is longer that this threshold |\n| `retryMax` | `3` | Number of time a consumer retry to import in case of failure |\n| `retryDelayS` | `2` | Delay between retries |\n| `logName` | `import/doc` | The name of the Log to tail |\n| `useBulkMode` | `false` | Process asynchronous listeners in bulk mode |\n| `blockIndexing` | `false` | Do not index created document with Elasticsearch |\n| `blockAsyncListeners` | `false` | Do not process any asynchronous listeners |\n| `blockPostCommitListeners` | `false` | Do not process any post commit listeners |\n| `blockDefaultSyncListeners` | `false` | Disable some default synchronous listeners: dublincore, mimetype, notification, template, binarymetadata and uid |\n\n### 4 steps import: Generate and Import blobs, then Generate and Import documents\n\n1. Run producers of random blob messages\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runRandomBlobProducers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"nbBlobs\": 100, \"nbThreads\": 5}}'\n```\n\n| Params| Default | Description |\n| --- | ---: | --- |\n| `nbBlobs` | | The number of blobs to generate per producer thread |\n| `nbThreads` | `8` | The number of concurrent producer to run |\n| `avgBlobSizeKB` | `1` | The average blob size fo each file documents in KB |\n| `lang` | `en_US` | The locale used for the generated content, can be \"fr_FR\" or \"en_US\" |\n| `logName` | `import/blob` | The name of the Log to append blobs. |\n| `logSize` | `$nbThreads`| The number of partitions in the Log which will fix the maximum number of consumer threads |\n\n2. Run consumers of blob messages importing into the Nuxeo binary store, saving blob information into a new Log.\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runBlobConsumers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"blobProviderName\": \"default\", \"logBlobInfo\": \"blob-info\"}}'\n```\n\n| Params| Default | Description |\n| --- | ---: | --- |\n| `blobProviderName` | `default` | The name of the binary store blob provider |\n| `logName` | `import/blob` | The name of the Log that contains the blob |\n| `logBlobInfo` | `import/blob-info` | The name of the Log to append blob information about imported blobs |\n| `nbThreads` | `$logSize` | The number of concurrent consumer, should not be greater than the number of partitions in the Log |\n| `retryMax` | `3` | Number of time a consumer retry to import in case of failure |\n| `retryDelayS` | `2` | Delay between retries |\n\n3. Run producers of random Nuxeo document messages which use produced blobs created in step 2\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runRandomDocumentProducers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"nbDocuments\": 200, \"nbThreads\": 5, \"logBlobInfo\": \"blob-info\"}}'\n```\nSame params listed in the previous previous runRandomDocumentProducers call, here we set the `logBlobInfo` parameter.\n\n4. Run consumers of document messages\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runDocumentConsumers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"rootFolder\": \"/default-domain/workspaces\"}}'\n```\n\nSame params listed in the previous previous runDocumentConsumers call.\n\n### Create blobs using existing files\n\nCreate a file containing the list of files to import then:\n\n1. Generate blob messages corresponding to the files, dispatch the messages into 4 partitions:\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runFileBlobProducers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"listFile\": \"/tmp/my-file-list.txt\", \"logSize\": 4}}'\n```\n\n| Params| Default | Description |\n| --- | ---: | --- |\n| `listFile` | | The path to the listing file |\n| `basePath` | '' | The base path to use as prefix of each file listed in the `listFile` |\n| `nbBlobs` | 0 | The number of blobs to generate per producer thread, 0 means all entries, loop on `listFile` entries if necessary |\n| `nbThreads` | `1` | The number of concurrent producer to run |\n| `logName` | `import/blob` | The name of the Log to append blobs. |\n| `logSize` | `$nbThreads`| The number of partitions in the Log which will fix the maximum number of consumer threads |\n\n\nThe you can use the 3 others steps describes the above section to import blobs with 4 threads and create documents.\n\nNote that the type of document will be adapted to the detected mime type of the file so that\n- image file will generate a `Picture` document\n- video file will generate a `Video` document\n- other type will be translated to `File` document\n\n\n### Generate random file for testing purpose\n\nFor testing purpose it can be handy to generate different file from an existing one, the goal is to generate lots of unique files with a limited set of files.\n\nTo do this you need to first generates blob messages pointing to file (see previous section) and choose the `nbBlobs` corresponding to the expected number of blob to import,\n(use a greater number that the existing files).\n\nThe next step is to add some special option to blob consumer so that instead of importing the existing file, a watermark will be\nadded to the blob before importing it.\n\n\n2. Run consumers of blob messages adding watermark to file and importing into the Nuxeo binary store, saving blob information into a new Log.\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runBlobConsumers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"watermark\": \"foo\"}}'\n```\n\nThe additional parameters are:\n\n| Params| Default | Description |\n| --- | ---: | --- |\n| `watermark` | | Ask to add a watermark to the file before importing it, use the provided string if possible. |\n| `persistBlobPath` | | Use a path if you want to keep the generated files on disk |\n| `blobProviderName` | `default` | If blank there is no Nuxeo blob import, this can be useful for import with Gatling/Redis |\n\n\nContinue with other steps described above to generate and create documents.\n\nNote that only few mime type are supported for watermark so far:\n- `text/plain`: Insert a uniq tag at the beginning of text.\n- `image/jpeg`: Set the exif software tag to a uniq tag.\n- `video/mp4`: Set the title with the uniq tag.\n\n\n### Import document using REST API via Gatling/Redis\n\nInstead of doing mass import creating document by batch with the efficient internal API,\nyou can save them into Redis in a way it can be used by Gatling simulation, this way we can stress the REST API.\n\nTo do this instead of the document creationg step 4 we do:\n\n4. Run Redis consumers of document messages\n ```\ncurl -X POST 'http://localhost:8080/nuxeo/site/automation/StreamImporter.runRedisDocumentConsumers' -u Administrator:Administrator -H 'content-type: application/json' \\\n -d '{\"params\":{\"rootFolder\": \"/default-domain/workspaces\"}}'\n```\n\nNote that the Nuxeo must be configured with Redis (`nuxeo.redis.enabled=true`).\n\nAfter this you need to use simulations in `nuxeo-distribution/nuxeo-jsf-ui-gatling-tests/`:\n\n```\n# init the infra, creating a group of test users and a workspace\nmvn -nsu gatling:test -Dgatling.simulationClass=org.nuxeo.cap.bench.Sim00Setup -Pbench -DredisDb=0 -Durl=http://localhost:8080/nuxeo\n\n# import the folder structure\nmvn -nsu gatling:test -Dgatling.simulationClass=org.nuxeo.cap.bench.Sim10CreateFolders -Pbench -DredisDb=0 -Durl=http://localhost:8080/nuxeo\n\n# import the documents using 8 concurrent users\nmvn -nsu gatling:test -Dgatling.simulationClass=org.nuxeo.cap.bench.Sim20CreateDocuments -Pbench -DredisDb=0 -Dusers=8 -Durl=http://localhost:8080/nuxeo\n\n```\n\nThe node running the Gatling simulation must have access to the files to import.\n\nHere is an overview of possible usage to generate mass import and load tests with the stream importer:\n\n![import diagram](import-diag.png)\n\nVisit [nuxe-jsf-ui-gatling](https://github.com/nuxeo/nuxeo/tree/master/ftests/nuxeo-server-gatling-tests) for more information.\n\n\n\n## Building\n\nTo build and run the tests, simply start the Maven build:\n\n mvn clean install\n\n## About Nuxeo\nNuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.\n", "digest": "293cef66d565f109fd63293a60051592", "encoding": "UTF-8", "length": 11724, "mimeType": "text/plain", "name": "README.md" }, "requirements": [], "version": "2021.49.2" } ], "creationDate": 1707128556778, "key": "Nuxeo Platform-2021.49", "name": "Nuxeo Platform", "operations": [ { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.importer.stream.automation.contrib", "description": "Import blob into the binarystore.", "hierarchyPath": "/op:StreamImporter.runBlobConsumers", "label": "Import blobs", "name": "StreamImporter.runBlobConsumers", "operationClass": "org.nuxeo.importer.stream.automation.BlobConsumers", "params": [ { "description": null, "isRequired": false, "name": "batchSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "batchThresholdS", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "blobProviderName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logBlobInfo", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "nbThreads", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "persistBlobPath", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "retryDelayS", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "retryMax", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "waitMessageTimeoutSeconds", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "watermark", "order": 0, "type": "string", "values": [], "widget": null } ], "signature": [ "void", "void" ], "since": "9.1", "url": "StreamImporter.runBlobConsumers", "version": "2021.49.2" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.importer.stream.automation.contrib", "description": "Import documents into repository.", "hierarchyPath": "/op:StreamImporter.runDocumentConsumers", "label": "Imports document", "name": "StreamImporter.runDocumentConsumers", "operationClass": "org.nuxeo.importer.stream.automation.DocumentConsumers", "params": [ { "description": null, "isRequired": true, "name": "rootFolder", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "batchSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "batchThresholdS", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "blockAsyncListeners", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "blockDefaultSyncListeners", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "blockIndexing", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "blockPostCommitListeners", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "nbThreads", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "repositoryName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "retryDelayS", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "retryMax", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "useBulkMode", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "waitMessageTimeoutSeconds", "order": 0, "type": "integer", "values": [], "widget": null } ], "signature": [ "void", "void" ], "since": "9.1", "url": "StreamImporter.runDocumentConsumers", "version": "2021.49.2" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.importer.stream.automation.contrib", "description": "Produces blobs from a list of files.", "hierarchyPath": "/op:StreamImporter.runFileBlobProducers", "label": "Produces blobs from a list of files", "name": "StreamImporter.runFileBlobProducers", "operationClass": "org.nuxeo.importer.stream.automation.FileBlobProducers", "params": [ { "description": null, "isRequired": true, "name": "listFile", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "basePath", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "nbBlobs", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "nbThreads", "order": 0, "type": "integer", "values": [], "widget": null } ], "signature": [ "void", "void" ], "since": "10.2", "url": "StreamImporter.runFileBlobProducers", "version": "2021.49.2" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.importer.stream.automation.contrib", "description": "Produces random blobs in a Log.", "hierarchyPath": "/op:StreamImporter.runRandomBlobProducers", "label": "Produces random blobs", "name": "StreamImporter.runRandomBlobProducers", "operationClass": "org.nuxeo.importer.stream.automation.RandomBlobProducers", "params": [ { "description": null, "isRequired": true, "name": "nbBlobs", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "avgBlobSizeKB", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "blobMarker", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "lang", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "nbThreads", "order": 0, "type": "integer", "values": [], "widget": null } ], "signature": [ "void", "void" ], "since": "9.1", "url": "StreamImporter.runRandomBlobProducers", "version": "2021.49.2" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.importer.stream.automation.contrib", "description": "Produces random blobs in a Log.", "hierarchyPath": "/op:StreamImporter.runRandomDocumentProducers", "label": "Produces random blobs", "name": "StreamImporter.runRandomDocumentProducers", "operationClass": "org.nuxeo.importer.stream.automation.RandomDocumentProducers", "params": [ { "description": null, "isRequired": true, "name": "nbDocuments", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "avgBlobSizeKB", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "countFolderAsDocument", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "lang", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logBlobInfo", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "logSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "nbThreads", "order": 0, "type": "integer", "values": [], "widget": null } ], "signature": [ "void", "void" ], "since": "9.1", "url": "StreamImporter.runRandomDocumentProducers", "version": "2021.49.2" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.importer.stream.automation.contrib", "description": "Import documents into Redis.", "hierarchyPath": "/op:StreamImporter.runRedisDocumentConsumers", "label": "Imports document into Redis", "name": "StreamImporter.runRedisDocumentConsumers", "operationClass": "org.nuxeo.importer.stream.automation.RedisDocumentConsumers", "params": [ { "description": null, "isRequired": false, "name": "logName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "nbThreads", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "redisPrefix", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "retryDelayS", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "retryMax", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "waitMessageTimeoutSeconds", "order": 0, "type": "integer", "values": [], "widget": null } ], "signature": [ "void", "void" ], "since": "10.1", "url": "StreamImporter.runRedisDocumentConsumers", "version": "2021.49.2" } ], "packages": [ { "@type": "NXPackage", "bundles": [ "org.nuxeo.ecm.platform.importer.core", "org.nuxeo.ecm.platform.importer.jaxrs", "org.nuxeo.importer.stream" ], "conflicts": [ "nuxeo-scan-importer" ], "dependencies": [], "hierarchyPath": "/nuxeo-platform-importer-2021.49.2", "id": "nuxeo-platform-importer-2021.49.2", "name": "nuxeo-platform-importer", "optionalDependencies": [], "packageType": "addon", "title": "Bulk document importer", "version": "2021.49.2" } ], "pluginSnapshots": {}, "releaseDate": 1707128556778, "version": "2021.49" }